Class FrameInstanceImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.FrameInstanceImpl
All Implemented Interfaces:
IPCObject, FrameInstance

public class FrameInstanceImpl extends IPCObjectImpl implements FrameInstance
Information provided by the PKI file:

    \class FrameInstance
    
    \brief FrameInstance holds traffic details such as PDUs, ports, etc.
    
    \example appWindow().getActiveFile().getMainSimulation().getFrameInstanceAt(0)
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getUserTrafficType

      public TrafficType getUserTrafficType()
      Information provided by the PKI file:
      
          \brief Returns the user traffic type.
          
          \return TrafficType, the user traffic type.
          User traffic types:
          eTrafficType_Icmp           = 0,
          eTrafficType_Tcp            = 1,
          eTrafficType_Udp            = 2,
          eTrafficType_RipV1          = 3,
          eTrafficType_RipV2          = 4,
          eTrafficType_Arp            = 5,
          eTrafficType_Cdp            = 6,
          eTrafficType_Dhcp           = 7,
          eTrafficType_Nat            = 8,
          eTrafficType_Eigrp          = 9,
          eTrafficType_Vtp            = 10,
          eTrafficType_Stp            = 11,
          eTrafficType_Ospf           = 12,
          eTrafficType_Dtp            = 13,
          eTrafficType_Telnet         = 14,
          eTrafficType_Ssh            = 15,
          eTrafficType_Tftp           = 16,
          eTrafficType_Http           = 17,
          eTrafficType_Https          = 18,
          eTrafficType_Dns            = 19,
          eTrafficType_Icmpv6         = 20,
          eTrafficType_Lacp           = 21,
          eTrafficType_Pagp           = 22,
          eTrafficType_Ipsec          = 23,
          eTrafficType_Ike            = 24,
          eTrafficType_Syslog         = 25,
          eTrafficType_Tacacs         = 26,
          eTrafficType_Radius         = 27,
          eTrafficType_Snmp           = 28,
          eTrafficType_Ntp            = 29,
          eTrafficType_Ftp            = 30,
          eTrafficType_Smtp           = 31,
          eTrafficType_Pop3           = 32,
          eTrafficType_Sccp           = 33,
          eTrafficType_Rtp            = 34,
          eTrafficType_H323           = 35,
          eTrafficType_Bgp            = 36,
          eTrafficType_Hsrp           = 37,
          eTrafficType_Hsrpv6         = 38,
          eTrafficType_Netflow        = 39,
          eTrafficType_Ndv6           = 40,
          eTrafficType_Ripng          = 41,
          eTrafficType_Dhcpv6         = 42,
          eTrafficType_Eigrpv6        = 43,
          eTrafficType_Ospfv6         = 44,
          eTrafficType_IoE            = 45,
          eTrafficType_Ptp            = 46,
          eTrafficType_Rep            = 47,
          eTrafficType_CapwapUdp      = 48,
          eTrafficType_Lldp           = 49,
          eTrafficType_Span           = 50,
          eTrafficType_IoETcp         = 51,
          eTrafficType_Usb            = 52,
          eTrafficType_Bluetooth      = 53,
          eTrafficType_Custom         = 1000
          
              
      Specified by:
      getUserTrafficType in interface FrameInstance
      Returns:
      TrafficType Returns a TrafficType
    • getDestinationString

      public String getDestinationString()
      Information provided by the PKI file:
      
          \brief Returns the destination.
          
          \return QString, the destination.
          
              
      Specified by:
      getDestinationString in interface FrameInstance
      Returns:
      String Returns a String
    • getSourceString

      public String getSourceString()
      Information provided by the PKI file:
      
          \brief Returns the source.
          
          \return QString, the source.
          
              
      Specified by:
      getSourceString in interface FrameInstance
      Returns:
      String Returns a String
    • getDevice

      public Device getDevice()
      Information provided by the PKI file:
      
          \brief Returns the current device the frame instance is at.
          
          \return Device, the Device object the frame instance is at.
          
              
      Specified by:
      getDevice in interface FrameInstance
      Returns:
      Device Returns a Device
    • getPreviousDevice

      public Device getPreviousDevice()
      Information provided by the PKI file:
      
          \brief Returns the previous device the frame instance was at.
          
          \return Device, the Device object the frame instance was at.
          
              
      Specified by:
      getPreviousDevice in interface FrameInstance
      Returns:
      Device Returns a Device
    • getInFrame

      public Pdu getInFrame()
      Information provided by the PKI file:
      
          \brief Returns the inbound frame.
          
          \return Pdu, the inbound frame Pdu object.
          
              
      Specified by:
      getInFrame in interface FrameInstance
      Returns:
      Pdu Returns a Pdu
    • getOutFrame

      public Pdu getOutFrame()
      Information provided by the PKI file:
      
          \brief Returns the outbound frame.
          
          \return Pdu, the outbound frame Pdu object.
          
              
      Specified by:
      getOutFrame in interface FrameInstance
      Returns:
      Pdu Returns a Pdu
    • getInPort

      public Port getInPort()
      Information provided by the PKI file:
      
          \brief Returns the inbound port.
          
          \return Port, the inbound Port object.
          
              
      Specified by:
      getInPort in interface FrameInstance
      Returns:
      Port Returns a Port
    • getOutPort

      public Port getOutPort(int outPortIndex)
      Information provided by the PKI file:
      
          \brief returns the outbound port at the specified index.
          
          \param outPortIndex, the index of the outbound port of interest.
          
          \return Port, the outbound Port object at the specified index.
          
              
      Specified by:
      getOutPort in interface FrameInstance
      Parameters:
      outPortIndex - Takes in a parameter of outPortIndex
      Returns:
      Port Returns a Port
    • getOutPortCount

      public int getOutPortCount()
      Information provided by the PKI file:
      
          \brief Returns the number of outbound ports.
          
          \return int, the number of outbound ports.
          
              
      Specified by:
      getOutPortCount in interface FrameInstance
      Returns:
      int Returns a int
    • addDecision

      public void addDecision(String id, String description, boolean isOsiIn, int osiLayer)
      Information provided by the PKI file:
      
          \brief Adds a flowchart decision with the specified ID and description at the specified layer.
          
          \param id, the flowchart ID.
          \param description, the flowchart description.
          \param isOsiIn, true if inbound layer decision, false if outbound layer decision.
          \param osiLayer, the OSI layer.
          
              
      Specified by:
      addDecision in interface FrameInstance
      Parameters:
      id - Takes in a parameter of id
      description - Takes in a parameter of description
      isOsiIn - Takes in a parameter of isOsiIn
      osiLayer - Takes in a parameter of osiLayer
    • getFlowChartNodeAt

      public FlowChartNode getFlowChartNodeAt(int nodeIndex)
      Information provided by the PKI file:
      
          \brief Returns the flowchart node at the specified index.
          
          \param nodeIndex, the index of the flowchart node of interest.
          
          \return FlowChartNode, the FlowChartNode object att he specified index.
          
              
      Specified by:
      getFlowChartNodeAt in interface FrameInstance
      Parameters:
      nodeIndex - Takes in a parameter of nodeIndex
      Returns:
      FlowChartNode Returns a FlowChartNode
    • getFrameDecsionAt

      public FrameDecision getFrameDecsionAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the frame decision at the specified index.
          
          \param index, the index of the frame decision of interest.
          
          \return FrameDecision, the FrameDecision at the specified index.
          
              
      Specified by:
      getFrameDecsionAt in interface FrameInstance
      Parameters:
      index - Takes in a parameter of index
      Returns:
      FrameDecision Returns a FrameDecision
    • getFlowChartNodeCount

      public int getFlowChartNodeCount()
      Information provided by the PKI file:
      
          \brief Returns the number of flowchart nodes.
          
          \return int, the number of flowchart nodes.
          
              
      Specified by:
      getFlowChartNodeCount in interface FrameInstance
      Returns:
      int Returns a int
    • getDecisionAt

      public String getDecisionAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the decision at the specified index.
          
          \param index, the index of the decision of interest.
          
          \return QString, the decision at the specified index.
          
              
      Specified by:
      getDecisionAt in interface FrameInstance
      Parameters:
      index - Takes in a parameter of index
      Returns:
      String Returns a String
    • setFrameSent

      public void setFrameSent(boolean sent)
      Information provided by the PKI file:
      
          \brief Sets the frame as sent or unsent.
          
          \param sent, true for sent, false for unsent.
          
              
      Specified by:
      setFrameSent in interface FrameInstance
      Parameters:
      sent - Takes in a parameter of sent
    • isFrameSent

      public boolean isFrameSent()
      Information provided by the PKI file:
      
          \brief Returns true if the the frame is sent, otherwise false.
          
          \return bool, true if the the frame is sent, otherwise false.
          
              
      Specified by:
      isFrameSent in interface FrameInstance
      Returns:
      boolean Returns a boolean
    • setFrameBuffered

      public void setFrameBuffered(boolean buffered)
      Information provided by the PKI file:
      
          \brief Sets the frame as buffered or unbuffered.
          
          \param buffered, true for buffered, false for unbuffered.
          
              
      Specified by:
      setFrameBuffered in interface FrameInstance
      Parameters:
      buffered - Takes in a parameter of buffered
    • isFrameBuffered

      public boolean isFrameBuffered()
      Information provided by the PKI file:
      
          \brief Returns true if the the frame is buffered, otherwise false.
          
          \return bool, true if the the frame is buffered, otherwise false.
          
              
      Specified by:
      isFrameBuffered in interface FrameInstance
      Returns:
      boolean Returns a boolean
    • setFrameDropped

      public void setFrameDropped(boolean dropped)
      Information provided by the PKI file:
      
          \brief Sets the frame as dropped or not dropped.
          
          \param dropped, true for dropped, false for not dropped.
          
              
      Specified by:
      setFrameDropped in interface FrameInstance
      Parameters:
      dropped - Takes in a parameter of dropped
    • isFrameDropped

      public boolean isFrameDropped()
      Information provided by the PKI file:
      
          \brief Returns true if the the frame is dropped, otherwise false.
          
          \return bool, true if the the frame is dropped, otherwise false.
          
              
      Specified by:
      isFrameDropped in interface FrameInstance
      Returns:
      boolean Returns a boolean
    • setFrameNotForwarded

      public void setFrameNotForwarded(boolean notForwarded)
      Information provided by the PKI file:
      
          \brief Sets the frame as not forwarded or forwarded.
          
          \param notForwarded, true for not forwarded, false for forwarded.
          
              
      Specified by:
      setFrameNotForwarded in interface FrameInstance
      Parameters:
      notForwarded - Takes in a parameter of notForwarded
    • isFrameNotForwarded

      public boolean isFrameNotForwarded()
      Information provided by the PKI file:
      
          \brief Returns true if the the frame is not forwarded, otherwise false.
          
          \return bool, true if the the frame is not forwarded, otherwise false.
          
              
      Specified by:
      isFrameNotForwarded in interface FrameInstance
      Returns:
      boolean Returns a boolean
    • setFrameAccepted

      public void setFrameAccepted(boolean accepted)
      Information provided by the PKI file:
      
          \brief Sets the frame as accepted or not accepted.
          
          \param accepted, true for accepted, false for not accepted.
          
              
      Specified by:
      setFrameAccepted in interface FrameInstance
      Parameters:
      accepted - Takes in a parameter of accepted
    • isFrameAccepted

      public boolean isFrameAccepted()
      Information provided by the PKI file:
      
          \brief Returns true if the the frame is accepted, otherwise false.
          
          \return bool, true if the the frame is accepted, otherwise false.
          
              
      Specified by:
      isFrameAccepted in interface FrameInstance
      Returns:
      boolean Returns a boolean
    • setFrameUnexpected

      public void setFrameUnexpected(boolean unexpected)
      Information provided by the PKI file:
      
          \brief Sets the frame as unexpected or expected.
          
          \param unexpected, true for unexpected, false for expected.
          
              
      Specified by:
      setFrameUnexpected in interface FrameInstance
      Parameters:
      unexpected - Takes in a parameter of unexpected
    • isFrameUnexpected

      public boolean isFrameUnexpected()
      Information provided by the PKI file:
      
          \brief Returns true if the the frame is unexpected, otherwise false.
          
          \return bool, true if the the frame is unexpected, otherwise false.
          
              
      Specified by:
      isFrameUnexpected in interface FrameInstance
      Returns:
      boolean Returns a boolean
    • isFrameCollidedOnLink

      public boolean isFrameCollidedOnLink()
      Information provided by the PKI file:
      
          \brief Returns true if the frame collided on the link, otherwise false.
          
          \return bool, true if the frame collided on the link, otherwise false.
          
              
      Specified by:
      isFrameCollidedOnLink in interface FrameInstance
      Returns:
      boolean Returns a boolean
    • isFrameCollidedAtDevice

      public boolean isFrameCollidedAtDevice()
      Information provided by the PKI file:
      
          \brief Returns true if the frame collided at the device, otherwise false.
          
          \return bool, true if the frame collided at the device, otherwise false.
          
              
      Specified by:
      isFrameCollidedAtDevice in interface FrameInstance
      Returns:
      boolean Returns a boolean
    • isFrameOnTransit

      public boolean isFrameOnTransit()
      Information provided by the PKI file:
      
          \brief Returns true if the frame is in transit, otherwise false.
          
          \return bool, true if the frame is in transit, otherwise false.
          
              
      Specified by:
      isFrameOnTransit in interface FrameInstance
      Returns:
      boolean Returns a boolean
    • getQosStampColorCode

      public int getQosStampColorCode()
      Information provided by the PKI file:
      
          \brief Returns the QoS stamp color code.
          
          \return int, the QoS stamp color code.
          
              
      Specified by:
      getQosStampColorCode in interface FrameInstance
      Returns:
      int Returns a int
    • getInQosStampColorCode

      public int getInQosStampColorCode()
      Information provided by the PKI file:
      
          \brief Returns the inbound QoS stamp color code.
          
          \return int, the inbound QoS stamp color code.
          
              
      Specified by:
      getInQosStampColorCode in interface FrameInstance
      Returns:
      int Returns a int
    • getOutQosStampColorCode

      public int getOutQosStampColorCode()
      Information provided by the PKI file:
      
          \brief Returns the outbound QoS stamp color code.
          
          \return int, the outbound QoS stamp color code.
          
              
      Specified by:
      getOutQosStampColorCode in interface FrameInstance
      Returns:
      int Returns a int
    • getTransitTime

      public int getTransitTime()
      Information provided by the PKI file:
      
          \brief Returns the transit time.
          
          \return int, the transit time.
          
              
      Specified by:
      getTransitTime in interface FrameInstance
      Returns:
      int Returns a int
    • getPercentageSent

      public int getPercentageSent()
      Information provided by the PKI file:
      
          \brief Returns the percentage of the frame that was sent.
          
          \return int, the percentage of the frame that was sent.
          
              
      Specified by:
      getPercentageSent in interface FrameInstance
      Returns:
      int Returns a int
    • getStartSimTime

      public long getStartSimTime()
      Information provided by the PKI file:
      
          \brief Returns the simulation start time.
          
          \return int, the simulation start time.
          
              
      Specified by:
      getStartSimTime in interface FrameInstance
      Returns:
      long Returns a long
    • getTrafficSource

      public UserTraffic getTrafficSource()
      Information provided by the PKI file:
      
          \brief Returns the traffic source.
          
          \return UserTraffic, the soure UserTraffic object.
          
              
      Specified by:
      getTrafficSource in interface FrameInstance
      Returns:
      UserTraffic Returns a UserTraffic
    • getTime

      public int getTime()
      Information provided by the PKI file:
      
          \brief Returns time of the frame instance.
          
          \return int, time of the frame instance.
          
              
      Specified by:
      getTime in interface FrameInstance
      Returns:
      int Returns a int